GET
/
v1
/
shipping
/
shipments
/
{id}
Get one Shipment
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/shipping/shipments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resource": {
    "type": "Shipment",
    "id": 3,
    "unique_id": "1100000003",
    "external_id": "<string>",
    "status": "new",
    "shipping_carrier_code": "fedex",
    "shipping_method": "<string>",
    "shipping_method_name": "<string>",
    "shipping_service_code": "<string>",
    "shipping_service_name": "fedex_FEDEX_2_DAY",
    "warehouse": {
      "type": "Warehouse",
      "id": 123
    },
    "order": {
      "type": "Order",
      "id": 123
    },
    "shipping_account": {
      "type": "ShippingAccount",
      "id": 4
    },
    "target_ship_date": "2023-12-25",
    "item_weight": {
      "value": 20,
      "unit": "lb"
    },
    "shipped_weight": {
      "value": 20,
      "unit": "lb"
    },
    "items": [
      {
        "type": "ShipmentItem",
        "id": 123,
        "product": {
          "type": "Product",
          "id": 3
        }
      }
    ],
    "packages": [
      {
        "items": [
          {}
        ],
        "packaging": [
          {}
        ],
        "collected_data": [
          {}
        ],
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "packing_solution": {
      "type": "ShipmentPackingSolution",
      "id": 3,
      "containers": [
        {
          "type": "ShipmentPackingSolutionContainer",
          "weight": {},
          "dimensions": {},
          "volume": {},
          "void_percent": 15.23,
          "regulation_type": "full",
          "items": [
            "<any>"
          ]
        }
      ]
    },
    "picking_class_id": "Default",
    "is_cutoff_date_exception": true,
    "is_manually_processed": true,
    "label_print_target": "label001",
    "scac": "FDEG",
    "carrier_shipping_cost": 3.9,
    "is_international": true,
    "is_documents_required": true,
    "is_electronic_customs": true,
    "infill_product_id": "kraft",
    "max_package_weight": 2.5,
    "packing_solution_providers": [
      "Provider 1",
      "Provider 2"
    ],
    "tpb_group": "ACME Inc",
    "created_at": "2017-07-21T17:32:28Z",
    "updated_at": "2017-07-21T17:39:43Z",
    "packed_at": "2017-07-21T17:32:28Z",
    "total_weight": {
      "value": 20,
      "unit": "lb"
    }
  },
  "included": {
    "Brand": [
      {
        "type": "Brand",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "is_active": true,
        "is_deleted": false,
        "sort_order": 0
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "Order": [
      {
        "type": "Order",
        "id": 3,
        "unique_id": "1100000003",
        "order_ref": "O-382227",
        "state": "new",
        "status": "new",
        "brand": {
          "type": "Brand",
          "id": 4,
          "code": "acme_inc",
          "name": "ACME Inc.",
          "is_active": true,
          "is_deleted": false,
          "sort_order": 0
        },
        "merchant": {
          "type": "Merchant",
          "id": 4,
          "code": "acme_inc",
          "name": "ACME Inc.",
          "status": "active",
          "created_at": "2017-07-21T17:32:28Z",
          "updated_at": "2017-07-21T17:39:43Z",
          "brands": [
            {
              "type": "Brand",
              "id": 4
            }
          ],
          "default_brand": {
            "type": "Brand",
            "id": 4
          }
        },
        "carrier_code": "fedex",
        "shipping_method": "fedex_FEDEX_2_DAY",
        "signature_required": "adult",
        "is_saturday_delivery": false,
        "is_overbox_required": false,
        "priority": 50,
        "requested_ship_date": "2021-02-21",
        "is_declared_value_service": true,
        "declared_value": {
          "amount": 99,
          "currency": "USD"
        },
        "shipping_address": {
          "type": "OrderAddress",
          "id": 4,
          "first_name": "Celina",
          "last_name": "Goalley",
          "company": "Thompson-Torp",
          "street": [
            "15491 West Whiteside Street"
          ],
          "city": "Springfield",
          "region": "MO",
          "postcode": "65807",
          "country": "US",
          "telephone": "(417) 123-4567",
          "email": "celina.goalley@example.com",
          "classification": "res",
          "is_valid": true
        },
        "items": [
          {
            "type": "OrderItem",
            "id": 4,
            "sku": "KDS2108",
            "order_item_ref": "<string>",
            "product": {
              "type": "Product",
              "id": 123
            },
            "qty_ordered": 4,
            "qty_assigned": 4,
            "qty_allocated": 0,
            "qty_backordered": 0,
            "qty_processing": 0,
            "qty_picked": 0,
            "qty_shipped": 4,
            "qty_cancel_requested": 0,
            "qty_canceled": 0,
            "row_weight": {
              "value": 20,
              "unit": "lb"
            }
          }
        ],
        "shipments": [
          {
            "type": "Shipment",
            "id": 123
          }
        ],
        "custom_greeting": "<string>",
        "status_history": [
          {
            "type": "OrderStatusHistory",
            "id": 3,
            "status": "new",
            "comment": "Changed shipping method to FedEx Ground",
            "notify_merchant": true,
            "user": {
              "type": "OrganizationUser",
              "id": 3
            },
            "script_id": 123,
            "created_at": "2017-07-21T17:32:28Z"
          }
        ],
        "other_shipping_options": {
          "virtual_excluded_services": [
            "/^ups_/",
            "fedex_FEDEX_2_DAY"
          ]
        },
        "duties_payor": {
          "payor": "third_party",
          "tpb_group_id": 3
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "completed_at": "2017-07-21T17:39:43Z"
      }
    ],
    "OrderAddress": [
      {
        "type": "OrderAddress",
        "id": 4,
        "first_name": "Celina",
        "last_name": "Goalley",
        "company": "Thompson-Torp",
        "street": [
          "15491 West Whiteside Street"
        ],
        "city": "Springfield",
        "region": "MO",
        "postcode": "65807",
        "country": "US",
        "telephone": "(417) 123-4567",
        "email": "celina.goalley@example.com",
        "classification": "res",
        "is_valid": true
      }
    ],
    "OrderItem": [
      {
        "type": "OrderItem",
        "id": 4,
        "sku": "KDS2108",
        "order_item_ref": "<string>",
        "product": {
          "type": "Product",
          "id": 123
        },
        "qty_ordered": 4,
        "qty_assigned": 4,
        "qty_allocated": 0,
        "qty_backordered": 0,
        "qty_processing": 0,
        "qty_picked": 0,
        "qty_shipped": 4,
        "qty_cancel_requested": 0,
        "qty_canceled": 0,
        "row_weight": {
          "value": 20,
          "unit": "lb"
        }
      }
    ],
    "OrderStatusHistory": [
      {
        "type": "OrderStatusHistory",
        "id": 3,
        "status": "new",
        "comment": "Changed shipping method to FedEx Ground",
        "notify_merchant": true,
        "user": {
          "type": "OrganizationUser",
          "id": 3
        },
        "script_id": 123,
        "created_at": "2017-07-21T17:32:28Z"
      }
    ],
    "PackagingContainer": [
      {
        "type": "PackagingContainer",
        "id": 123,
        "container_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "dimensions": {
            "length": 8,
            "width": 6,
            "height": 4,
            "unit": "in"
          },
          "volume": {
            "value": 300,
            "unit": "in^3"
          },
          "manage_stock": true,
          "associated_products": [
            {}
          ],
          "allow_for_brands": [
            {}
          ],
          "disallow_for_brands": [
            {}
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_warehouses": [
            {}
          ],
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "satisfies_overbox": true,
          "use_for_bin_packing": "yes",
          "weight_capacity": {
            "value": 20,
            "unit": "lb"
          },
          "container_style": "rigid_box",
          "packaging_handling_surcharge": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingDataCollection": [
      {
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "type": "PackagingDataCollection",
        "id": 123,
        "data_collection_options": {
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true,
          "collect_data_pattern": "<string>",
          "apply_to_region": "<string>",
          "is_collected_data_unique": true
        }
      }
    ],
    "PackagingInfill": [
      {
        "type": "PackagingInfill",
        "id": 123,
        "infill_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "manage_stock": true,
          "associated_products": [
            {}
          ],
          "allow_for_brands": [
            {}
          ],
          "disallow_for_brands": [
            {}
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "disable_confirm_button": true,
          "apply_unless_container_meets_hazmat": true,
          "is_confirmation_required": true,
          "infill_horizontal": {
            "value": 12,
            "unit": "in"
          },
          "infill_vertical": {
            "value": 12,
            "unit": "in"
          },
          "infill_priority": 123
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingInstruction": [
      {
        "type": "PackagingInstruction",
        "id": 123,
        "instruction_options": {
          "barcodes": "956623520-4",
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_to_region": "<string>",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingSupplies": [
      {
        "type": "PackagingSupplies",
        "id": 123,
        "supplies_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "manage_stock": true,
          "associated_products": [
            {}
          ],
          "allow_for_brands": [
            {}
          ],
          "disallow_for_brands": [
            {}
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_warehouses": [
            {}
          ],
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "packaging_handling_surcharge": true,
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_to_region": "<string>",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Product": [
      {
        "type": "Product",
        "id": 123,
        "vendor_sku": "Vendor-SKU-1AD2",
        "external_id": "11-993-9048",
        "barcodes": [
          "956623520-4",
          "O-VS-Oregano-p3"
        ],
        "goods_type": "NORMAL",
        "is_available": true,
        "is_visible": true,
        "lot_type": {
          "type": "LotType",
          "id": 4
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "dimensions": {
          "length": 8,
          "width": 6,
          "height": 4,
          "unit": "in"
        },
        "volume": {
          "value": 300,
          "unit": "in^3"
        },
        "inventory": {
          "backorders": true,
          "dynamic_allocation": true,
          "virtual_inventory": "optimistic"
        },
        "export": {
          "description": "Plastic children's toy with steel weights and ball bearings",
          "customs_value": {
            "amount": 99,
            "currency": "USD"
          },
          "country_of_manufacture": "TW",
          "hs_base_code": "8518.30",
          "hs_country_extension": [
            {
              "country_id": "TW",
              "extension": "002"
            },
            {
              "country_id": "US",
              "extension": "011"
            }
          ]
        },
        "regulated_goods": {
          "regulation": {
            "type": "Regulation",
            "id": 123
          },
          "technical_name": "Hydro Polymer Acetylene Coating",
          "additional_information": "Flamable Liquid",
          "net_weight": {
            "value": 20,
            "unit": "lb"
          },
          "container_type": "Plastic Box",
          "container_meets_hazmat_specs": true,
          "regulation_units": 5
        },
        "packaging": {
          "require_packaging": true,
          "require_weight_check": true,
          "require_confirmation_per_item": true,
          "unit_quantity": 1,
          "bulk_quantity": 10,
          "max_per_package": 15,
          "is_ship_separately": true,
          "ship_separately_tag": "PVC",
          "can_tip": true,
          "can_contain_other_items": true,
          "is_handling_surcharge": true
        },
        "custom_fields": [
          {
            "code": "color",
            "value": 13,
            "label": "Red and Black"
          },
          {
            "code": "cost_of_goods",
            "value": 41.32
          },
          {
            "code": "allow_mailer",
            "value": true
          }
        ],
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Shipment": [
      {
        "type": "Shipment",
        "id": 3,
        "unique_id": "1100000003",
        "external_id": "<string>",
        "status": "new",
        "shipping_carrier_code": "fedex",
        "shipping_method": "<string>",
        "shipping_method_name": "<string>",
        "shipping_service_code": "<string>",
        "shipping_service_name": "fedex_FEDEX_2_DAY",
        "warehouse": {
          "type": "Warehouse",
          "id": 123
        },
        "order": {
          "type": "Order",
          "id": 123
        },
        "shipping_account": {
          "type": "ShippingAccount",
          "id": 4
        },
        "target_ship_date": "2023-12-25",
        "item_weight": {
          "value": 20,
          "unit": "lb"
        },
        "shipped_weight": {
          "value": 20,
          "unit": "lb"
        },
        "items": [
          {
            "type": "ShipmentItem",
            "id": 123,
            "product": {
              "type": "Product",
              "id": 3
            }
          }
        ],
        "packages": [
          {
            "items": [
              {}
            ],
            "packaging": [
              {}
            ],
            "collected_data": [
              {}
            ],
            "created_at": "2017-07-21T17:32:28Z",
            "updated_at": "2017-07-21T17:39:43Z"
          }
        ],
        "packing_solution": {
          "type": "ShipmentPackingSolution",
          "id": 3,
          "containers": [
            {
              "type": "ShipmentPackingSolutionContainer",
              "weight": {},
              "dimensions": {},
              "volume": {},
              "void_percent": 15.23,
              "regulation_type": "full",
              "items": [
                "<any>"
              ]
            }
          ]
        },
        "picking_class_id": "Default",
        "is_cutoff_date_exception": true,
        "is_manually_processed": true,
        "label_print_target": "label001",
        "scac": "FDEG",
        "carrier_shipping_cost": 3.9,
        "is_international": true,
        "is_documents_required": true,
        "is_electronic_customs": true,
        "infill_product_id": "kraft",
        "max_package_weight": 2.5,
        "packing_solution_providers": [
          "Provider 1",
          "Provider 2"
        ],
        "tpb_group": "ACME Inc",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "packed_at": "2017-07-21T17:32:28Z",
        "total_weight": {
          "value": 20,
          "unit": "lb"
        }
      }
    ],
    "ShipmentItem": [
      {
        "type": "ShipmentItem",
        "id": 123,
        "sku": "KDS2108",
        "product": {
          "type": "Product",
          "id": 123
        },
        "quantity": 4,
        "qty_shipped": 4,
        "qty_picked": 0,
        "qty_canceled": 0,
        "qty_cancel_requested": 0,
        "order_item": {
          "type": "OrderItem",
          "id": 123
        },
        "reservations": [
          {
            "location": {
              "type": "Location",
              "id": 42
            },
            "quantity": 123
          }
        ]
      }
    ],
    "ShipmentPackage": [
      {
        "items": [
          {}
        ],
        "packaging": [
          {}
        ],
        "collected_data": [
          {}
        ],
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "ShipmentPackageItem": [
      {
        "sku": "<string>",
        "name": "<string>",
        "quantity": 123,
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "hazmat_unit_weight": {
          "value": 20,
          "unit": "lb"
        },
        "customs_value": {
          "amount": 99,
          "currency": "USD"
        },
        "order_item_id": 123,
        "order_item_sku": "<string>",
        "order_item_quantity": 123
      }
    ],
    "ShipmentPackingSolution": [
      {
        "type": "ShipmentPackingSolution",
        "id": 3,
        "containers": [
          {
            "type": "ShipmentPackingSolutionContainer",
            "weight": {},
            "dimensions": {},
            "volume": {},
            "void_percent": 15.23,
            "regulation_type": "full",
            "items": [
              "<any>"
            ]
          }
        ]
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
id
integer
required

The id of the referenced Shipment.

Required range: x >= 1

Query Parameters

​
fields
enum<string>[]

Specify additional fields of the Shipment object to be included in the response. See the selecting fields page for more information.

​
fields:items
enum<string>[]

Specify additional fields of the ShipmentItem object to be included in the response. See the selecting fields page for more information.

​
fields:items.product
enum<string>[]

Specify additional fields of the Product objects to be included in the response. See the selecting fields page for more information.

​
fields:items.order_item
enum<string>[]

Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.

​
fields:order
enum<string>[]

Specify additional fields of the Order object to be included in the response. See the selecting fields page for more information.

​
fields:order.items
enum<string>[]

Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.

​
fields:order.shipments
enum<string>[]

Specify additional fields of the Shipment object to be included in the response. See the selecting fields page for more information.

​
fields:order.merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

​
fields:order.brand
enum<string>[]

Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.

​
fields:order.shipping_address
enum<string>[]

Specify additional fields of the OrderAddress object to be included in the response. See the selecting fields page for more information.

​
fields:order.status_history
enum<string>[]

Specify additional fields of the OrderStatusHistory object to be included in the response. See the selecting fields page for more information.

​
fields:warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response. See the selecting fields page for more information.

​
fields:packages
enum<string>[]

Specify additional fields of the ShipmentPackage object to be included in the response. See the selecting fields page for more information.

​
fields:packages.items
enum<string>[]

Specify additional fields of the ShipmentPackageItem object to be included in the response. See the selecting fields page for more information.

​
fields:packing_solution
enum<string>[]

Specify additional fields of the ShipmentPackingSolution object to be included in the response. See the selecting fields page for more information.

Response

OK

​
resource
object

A Shipment represents one or more pickable items which may constitute a whole or part of an Order. Shipments are assigned directly to a Warehouse which is the origin for the shipment. Once packed, a Shipment will represent one or more packages containing all of the shipment items.

​
included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.